kotlin-stdlib/kotlin.collections/[Common]MutableCollection

MutableCollection

interface MutableCollection<E> : Collection<E> , MutableIterable<E>

A generic collection of elements that supports adding and removing elements.

Parameters

the type of elements contained in the collection. The mutable collection is invariant in its element type.

Functions

add

abstract fun add(element: E): Boolean

Adds the specified element to the collection.

addAll

abstract fun addAll(elements: Collection<E>): Boolean

Adds all of the elements of the specified collection to this collection.

clear

abstract fun clear()

Removes all elements from this collection.

contains

abstract operator fun contains(element: E): Boolean

containsAll

abstract fun containsAll(elements: Collection<E>): Boolean

isEmpty

abstract fun isEmpty(): Boolean

iterator

abstract operator override fun iterator(): MutableIterator<E>

remove

abstract fun remove(element: E): Boolean

Removes a single instance of the specified element from this collection, if it is present.

removeAll

abstract fun removeAll(elements: Collection<E>): Boolean

Removes all of this collection's elements that are also contained in the specified collection.

retainAll

abstract fun retainAll(elements: Collection<E>): Boolean

Retains only the elements in this collection that are contained in the specified collection.

Properties

size

abstract val size: Int

Inheritors

MutableList

MutableSet

AbstractMutableCollection

Extensions

addAll

fun <T> MutableCollection<in T>.addAll(elements: Iterable<T>): Boolean

Adds all elements of the given elements collection to this MutableCollection.

fun <T> MutableCollection<in T>.addAll(elements: Sequence<T>): Boolean

Adds all elements of the given elements sequence to this MutableCollection.

fun <T> MutableCollection<in T>.addAll(elements: Array<out T>): Boolean

Adds all elements of the given elements array to this MutableCollection.

minusAssign

inline operator fun <T> MutableCollection<in T>.minusAssign(element: T)

Removes a single instance of the specified element from this mutable collection.

inline operator fun <T> MutableCollection<in T>.minusAssign(elements: Iterable<T>)

Removes all elements contained in the given elements collection from this mutable collection.

inline operator fun <T> MutableCollection<in T>.minusAssign(elements: Array<T>)

Removes all elements contained in the given elements array from this mutable collection.

inline operator fun <T> MutableCollection<in T>.minusAssign(elements: Sequence<T>)

Removes all elements contained in the given elements sequence from this mutable collection.

plusAssign

inline operator fun <T> MutableCollection<in T>.plusAssign(element: T)

Adds the specified element to this mutable collection.

inline operator fun <T> MutableCollection<in T>.plusAssign(elements: Iterable<T>)

Adds all elements of the given elements collection to this mutable collection.

inline operator fun <T> MutableCollection<in T>.plusAssign(elements: Array<T>)

Adds all elements of the given elements array to this mutable collection.

inline operator fun <T> MutableCollection<in T>.plusAssign(elements: Sequence<T>)

Adds all elements of the given elements sequence to this mutable collection.

remove

inline fun <T> MutableCollection<out T>.remove(element: T): Boolean

Removes a single instance of the specified element from this collection, if it is present.

removeAll

inline fun <T> MutableCollection<out T>.removeAll(elements: Collection<T>): Boolean

Removes all of this collection's elements that are also contained in the specified collection.

fun <T> MutableCollection<in T>.removeAll(elements: Iterable<T>): Boolean

Removes all elements from this MutableCollection that are also contained in the given elements collection.

fun <T> MutableCollection<in T>.removeAll(elements: Sequence<T>): Boolean

Removes all elements from this MutableCollection that are also contained in the given elements sequence.

fun <T> MutableCollection<in T>.removeAll(elements: Array<out T>): Boolean

Removes all elements from this MutableCollection that are also contained in the given elements array.

retainAll

inline fun <T> MutableCollection<out T>.retainAll(elements: Collection<T>): Boolean

Retains only the elements in this collection that are contained in the specified collection.

fun <T> MutableCollection<in T>.retainAll(elements: Iterable<T>): Boolean

Retains only elements of this MutableCollection that are contained in the given elements collection.

fun <T> MutableCollection<in T>.retainAll(elements: Array<out T>): Boolean

Retains only elements of this MutableCollection that are contained in the given elements array.

fun <T> MutableCollection<in T>.retainAll(elements: Sequence<T>): Boolean

Retains only elements of this MutableCollection that are contained in the given elements sequence.